<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Get metadata about a variable, like its type, short name, long definition, decimal places, etc. — varinfo • EJAM</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Get metadata about a variable, like its type, short name, long definition, decimal places, etc. — varinfo"><meta name="description" content="This is just a way to query map_headernames, which has info about each indicator or
variable used in EJAM."><meta property="og:description" content="This is just a way to query map_headernames, which has info about each indicator or
variable used in EJAM."><meta property="og:image" content="https://usepa.github.io/EJAM/logo.svg"></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">EJAM</a>

    <small class="nav-text text-warning me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">2.32.0</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Overview for EJAM Users</h6></li>
    <li><a class="dropdown-item" href="../articles/0_whatis.html">What is EJAM</a></li>
    <li><a class="dropdown-item" href="../articles/0_webapp.html">Using EJAM</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>For analysts using R</h6></li>
    <li><a class="dropdown-item" href="../articles/1_installing.html">Installing the EJAM R package</a></li>
    <li><a class="dropdown-item" href="../articles/2_quickstart.html">Quick Start Guide</a></li>
    <li><a class="dropdown-item" href="../articles/3_analyzing.html">Basics of Using EJAM for Analysis in RStudio</a></li>
    <li><a class="dropdown-item" href="../articles/4_advanced.html">Advanced Features</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/USEPA/EJAM/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">
      <img src="../logo.svg" class="logo" alt=""><h1>Get metadata about a variable, like its type, short name, long definition, decimal places, etc.</h1>
      <small class="dont-index">Source: <a href="https://github.com/USEPA/EJAM/blob/HEAD/R/varinfo.R" class="external-link"><code>R/varinfo.R</code></a></small>
      <div class="d-none name"><code>varinfo.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>This is just a way to query map_headernames, which has info about each indicator or
variable used in EJAM.</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">varinfo</span><span class="op">(</span></span>
<span>  var <span class="op">=</span> <span class="va">map_headernames</span><span class="op">$</span><span class="va">rname</span>,</span>
<span>  info <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/colnames.html" class="external-link">colnames</a></span><span class="op">(</span><span class="va">map_headernames</span><span class="op">)</span>,</span>
<span>  varnametype <span class="op">=</span> <span class="st">"rname"</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-var">var<a class="anchor" aria-label="anchor" href="#arg-var"></a></dt>
<dd><p>vector of variable names such as c("pctlowinc", "pm") or c(names_d, names_d_subgroups)
(and must be found in the column of map_headernames indicated by varnametype parameter below).</p></dd>


<dt id="arg-info">info<a class="anchor" aria-label="anchor" href="#arg-info"></a></dt>
<dd><p>types of metadata/info needed, such as "decimals", "long", etc.
which should be among colnames of map_headernames,
or alias like "long" as allowed by <code><a href="fixcolnames.html">fixcolnames()</a></code></p></dd>


<dt id="arg-varnametype">varnametype<a class="anchor" aria-label="anchor" href="#arg-varnametype"></a></dt>
<dd><p>optional. colname of map_headernames to use when looking for var,
like "rname" or "api" or "long"</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>data.frame of 1 or more rows, 1 or more columns, where</p>
<p>rowsnames are var (indicators like "pctmin")</p>
<p>colnames are info (metadata   like "decimals")</p>
<p>Cells of table are metadata such as what type of indicator is that var, how many
decimal places of rounding should be displayed for it in tables, etc.</p>
<p>Results can be character, numeric, etc. depending on what info is requested</p>
    </div>
    <div class="section level2">
    <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
    <p>See map_headernames for what kind of information is available there.
But if a variable appears twice+ in var or in map_headernames, info returned only for the 1st row of those.</p>
<p>Developers may wish to know about these functions,
several of which are not exported:</p><ul><li><p><code>varinfo()</code></p></li>
<li><p><code><a href="varname2varcategory_ejam.html">varname2varcategory_ejam()</a></code></p></li>
<li><p><code><a href="varname2vartype_ejam.html">varname2vartype_ejam()</a></code></p></li>
<li><p><code><a href="table_rounding_info.html">table_rounding_info()</a></code></p></li>
<li><p>EJAM table_signif_round_x100()</p></li>
<li><p><code><a href="fixcolnames.html">fixcolnames()</a></code></p></li>
<li><p><code><a href="fixcolnames_infer.html">fixcolnames_infer()</a></code></p></li>
<li><p>EJAM fixcolnames2related()</p></li>
<li><p>EJAM fixmapheadernamescolname()</p></li>
<li><p>EJAM is.numericish()</p></li>
<li><p>EJAM varin_map_headernames()</p></li>
<li><p>EJAM namesbyvarlist()</p></li>
<li><p>EJAM names_whichlist()</p></li>
<li><p>EJAM names_whichlist_multi()</p></li>
<li><p>EJAM names_whichlist_multi_key()</p></li>
<li><p>EJAM formula_varname()</p></li>
</ul><p>and the various related data objects like map_headernames and namez</p>
    </div>
    <div class="section level2">
    <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
    <div class="dont-index"><p><code><a href="fixcolnames.html">fixcolnames()</a></code> <code><a href="table_rounding_info.html">table_rounding_info()</a></code></p></div>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">varinfo</span><span class="op">(</span><span class="st">"traffic.score"</span>, <span class="st">"decimals"</span><span class="op">)</span></span>
<span><span class="fu">varinfo</span><span class="op">(</span><span class="va">names_d</span>, <span class="st">"long"</span><span class="op">)</span></span>
<span><span class="va">myvars</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="va">names_d</span>, <span class="va">names_d_subgroups</span>, <span class="va">names_e</span><span class="op">)</span></span>
<span><span class="va">myinfo</span> <span class="op">&lt;-</span> <span class="st">"percentage"</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/cbind.html" class="external-link">cbind</a></span><span class="op">(</span>  is.a.percentage <span class="op">=</span> <span class="fu">varinfo</span><span class="op">(</span><span class="va">myvars</span>, <span class="va">myinfo</span><span class="op">)</span> <span class="op">)</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/cbind.html" class="external-link">cbind</a></span><span class="op">(</span><span class="fu">varinfo</span><span class="op">(</span><span class="va">names_all_r</span>, <span class="st">"pctile."</span><span class="op">)</span><span class="op">)</span></span>
<span><span class="va">myinfo</span> <span class="op">&lt;-</span> <span class="st">"long"</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/cbind.html" class="external-link">cbind</a></span><span class="op">(</span><span class="fu">varinfo</span><span class="op">(</span><span class="va">myvars</span>, <span class="va">myinfo</span><span class="op">)</span> <span class="op">)</span></span>
<span><span class="fu"><a href="table_rounding_info.html">table_rounding_info</a></span><span class="op">(</span><span class="va">names_e</span><span class="op">)</span></span>
<span></span>
<span><span class="fu">varinfo</span><span class="op">(</span></span>
<span> var <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="va">names_these</span>, <span class="va">names_d_pctile</span><span class="op">)</span>,</span>
<span> info <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span></span>
<span> <span class="st">"topic_root_term"</span>, <span class="st">"varcategory"</span>, <span class="st">"vartype"</span>, <span class="st">"percentage"</span>, <span class="st">"pctile."</span>, <span class="st">"calculation_type"</span></span>
<span><span class="op">)</span><span class="op">)</span></span>
<span></span>
<span><span class="fu">varinfo</span><span class="op">(</span><span class="va">names_all_r</span>, <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"varcategory"</span>, <span class="st">"varlist"</span>, <span class="st">"in_api"</span>, <span class="st">"in_bgcsv"</span><span class="op">)</span><span class="op">)</span></span>
<span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/cbind.html" class="external-link">cbind</a></span><span class="op">(</span></span>
<span>  <span class="va">namez</span><span class="op">$</span><span class="va">d</span>, </span>
<span>  <span class="va">names_d</span>, </span>
<span>  <span class="fu">varinfo</span><span class="op">(</span><span class="va">names_d</span>, <span class="st">"varlist"</span><span class="op">)</span>, </span>
<span>  usavg <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/unlist.html" class="external-link">unlist</a></span><span class="op">(</span><span class="va">avg.in.us</span><span class="op">[</span><span class="va">names_d</span><span class="op">]</span><span class="op">)</span>, </span>
<span>  usavg_varname <span class="op">=</span> <span class="fu">EJAM</span><span class="fu">:::</span><span class="fu"><a href="fixcolnames2related.html">fixcolnames2related</a></span><span class="op">(</span><span class="va">names_d</span>, <span class="st">"usavg"</span><span class="op">)</span>, </span>
<span>  categ <span class="op">=</span> <span class="fu"><a href="varname2varcategory_ejam.html">varname2varcategory_ejam</a></span><span class="op">(</span><span class="va">names_d</span><span class="op">)</span></span>
<span><span class="op">)</span></span>
<span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/names.html" class="external-link">names</a></span><span class="op">(</span><span class="va">map_headernames</span><span class="op">)</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/t.html" class="external-link">t</a></span><span class="op">(</span><span class="fu">varinfo</span><span class="op">(</span><span class="va">names_d</span><span class="op">[</span><span class="fl">1</span><span class="op">]</span><span class="op">)</span><span class="op">)</span></span>
<span></span></code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>US EPA 2024</p>
</div>

<div class="pkgdown-footer-right">
  <p>EJAM Version 2.32.0</p>
</div>

    </footer></div>





  </body></html>

